home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 43 / Mac Magazin and MacEasy Magazine CD - Issue 43.iso / Software / Grafik / Web-Publishing / Cinnamon WebMaster Suite 1.1.3 / Read Me Please! < prev    next >
Text File  |  1998-03-02  |  17KB  |  251 lines

  1.             Cinnamon WebMaster Suite
  2.                                                                                                         Version 1.1.3
  3.  
  4. ***** Please read this document thoroughly, but for a quick over- *****
  5. ***** view of changes and new features in this version, please see *****
  6. ***** the "Version History" section at the bottom.                              *****
  7.  
  8. Contents
  9.  
  10.     Introduction
  11.     What is Cinnamon WebMaster Suite?
  12.     How to use CWMS
  13.     Special Features
  14.     How much does Cinnamon WebMaster Suite cost?
  15.     About Cinnamon Computer Products
  16.     Licensing and Distribution Information
  17.     Future Additions
  18.     Compatibility
  19.     Known Problems & Issues
  20.     Version History
  21.     BugZappers Hall of Fame ** New Section **
  22.     Legal Information
  23.  
  24. Introduction
  25.  
  26. Thank you for downloading Cinnamon WebMaster Suite! This is the first product of Cinnamon Soft, a division of Cinnamon Computer Products. Cinnamon WebMaster Suite (CWMS) will eventually turn into a full-fledged commercial product, but for now it was created for my own use. I have decided to release it as shareware in the meantime, because it is already a fully-functional and very useful product.
  27.  
  28. What is Cinnamon WebMaster Suite?
  29.  
  30. CWMS is a straightforward, yet very useful and useable, HTML editor. It is the perfect solution for Mac OS-based Web Page Design. It is compact, yet full of features.
  31.  
  32. Cinnamon WebMaster Suite was created to fulfill a need. WYSIWYG web page programs such as Adobe Pagemill just simply don't do the job. If I was going to have to write my own HTML, I needed a good editor--one that did more than a regular word processor, one that specifically helped me write web pages. It was out of this need that I created CWMS. It has all the capabilities of a simple text editor, with many special features dealing with HTML. As you read about and use Cinnamon WebMaster Suite, you will begin to discover these wonderful features. They hide well, but always ready to spring into action!
  33.  
  34. How to use CWMS
  35.  
  36. Using Cinnamon WebMaster Suite is quite easy. Everything is standard Mac OS. To open the program, you can double-click its icon or the icon of a document created by CWMS.
  37.  
  38. The Apple Menu
  39. • About Cinnamon WebMaster Suite
  40.     Displays information about CWMS
  41. • About Cinnamon Soft
  42.     Displays information about CCP
  43.  
  44. The File Menu
  45. • New
  46.     Creates a blank new document
  47. • Open…
  48.     Open an existing document (Usually an HTML document, but you can open any TEXT file)
  49. • Close
  50.     Close the current document
  51. • Save
  52.     Save the current document (If untitled, will automatically function as Save As…)
  53. • Save As…
  54.     Saves the current document as a new document and switches to the new one
  55. • Export…
  56.     Saves the current document as a new document without switching to the new one
  57. • Quit
  58.     Quits the program after closing all open documents
  59.  
  60. The Edit Menu
  61. • Undo
  62.     Undo does not function in this version of CWMS (see Future Additions, below)
  63. • Cut, Copy, Paste, Clear
  64.     The standard Mac OS clipboard commands
  65. • Select All
  66.     Selects the entire document
  67. • Insert Color
  68.     Using the Apple Color Picker, automatically formats and inserts the HTML color code
  69. • Colorize Text in Selection
  70.     Color-codes the tags & comments in the selected area of text
  71. • Preferences
  72.     Preferences does not function in this version of CWMS (see Future Additions, below)
  73.  
  74. The Window Menu
  75.     Any open documents are displayed under this menu, in alphabetical order
  76.  
  77. Special Features
  78.  
  79. What makes Cinnamon WebMaster Suite useful are the HTML-specific features. Here is an explanation of all current features:
  80.  
  81. • Color-coding
  82.     All text is color-coded for ease of reading. HTML tags are blue, comments are green,
  83.     and all other text is black.
  84. • Automatic Capitalization of tags
  85.     It is customary to type HTML tags in all-caps, but it is very annoying to have to keep
  86.     switching Caps Lock on and off all the time. Go ahead and type tags in lowercase, and
  87.     CWMS will automatically convert each tag to uppercase when you type the ">" at the
  88.     end of the tag. Also, it is smart enough not to convert text which is in quotes.
  89.   NOTE: If you use JavaScript, please see "Known Problems & Issues" below.
  90. • ISO-Latin Key Filtering
  91.     CWMS will only allow you to type characters which can be represented in the standard 
  92.     character set of the Internet. (see next item for related info)
  93. • Automatic Special Character Conversion
  94.     In Internet character sets, special characters are represented with embedded
  95.     shortcut values or phrases. For example, "á" should be entered into a web page using
  96.     "á" or else the incorrect character will be displayed on other computer types.
  97.     CWMS automatically converts special characters to their special codes. Type special
  98.     characters just as you normally would on a Macintosh. If nothing appears, you cannot
  99.     use that particular character on the Internet, although almost all characters can be.
  100. • Smart Entry of Multi-Purpose Characters
  101.     There are several characters which, in addition to being part of regular text, are also
  102.     used within HTML commands. These characters include "<", ">", "&", and """. A simple
  103.     and powerful shortcut has been devised: The first time you type one of these
  104.     characters, it is assumed that you meant to use them for HTML code, and they appear
  105.     like normal. If you instead wanted the character-code to be inserted, all you have to
  106.     do is type the character again! Any time you type one of these characters a second
  107.     time in a row, the first one is automatically removed and replaced with the code!
  108. • Smart Comments maintain compatibility
  109.     The old way of creating a comment was to make a single tag starting with "<!". The
  110.     new method is to use the <COMMENT> and </COMMENT> tags. CWMS supports both
  111.     methods, but you should always use the new method because the old method will not
  112.     be supported in future web browsers, causing your comments to be displayed as part
  113.     of the page. The recommended method is to use both--place the <!--> tag between the
  114.     <COMMENT> and </COMMENT> tags. This way, all browsers will see one or the other.
  115.     If you begin typing an old-style comment, CWMS will assist you by automatically
  116.     converting it to a mixed-style comment. CWMS will not modify new-style comments.
  117.     NEW FEATURE in v1.1: "</!" is now a shortcut for "</COMMENT"
  118. • "Insert Color" option
  119.     This shortcut command makes it easy to insert or modify HTML color hex codes. NEW
  120.     FEATURE in v1.1.1: In order to further enhance the useability of Insert Color, it has
  121.     been significantly improved. The "#" symbol is now smart, i.e. it will automatically
  122.     be inserted at the beginning of the hex code only if there isn't already one there. Also,
  123.     by double-clicking the hex value of a preexisting color before choosing Insert Color,
  124.     the "old" color in the color picker will be the preexisting color. If no preexisting color
  125.     is selected, the last color that was inserted (into any document) is the default color.
  126. • NEW FEATURE in v1.1.2: "Colorize Tags in Selection" option
  127.     This option color-codes all the tags & comments in the selected area of text. Useful
  128.     for updating the colorization of tags which may have been uncolorized during editing.
  129.     The process can be stopped at any time with command-period.
  130.  
  131. How much does Cinnamon WebMaster Suite cost?
  132.  
  133. Version 1.1.3 is a free update to anyone who has paid for any previous version. Send in those registrations! Otherwise:
  134.  
  135. Cinnamon WebMaster Suite is $5.00 shareware. Iowa residents must add 5% sales tax ($5.25 is the total). This program is being distributed on a shareware basis because it isn't ready to be sold commercially, but it's plenty good enough to be quite useful. By registering as a user of Cinnamon WebMaster Suite, you will gain several advantages:
  136.  
  137. • Email notification of new versions or products
  138. • A clear conscience knowing that you're honest
  139. • Free updates for a long time
  140. • I will be encouraged to continue to expand CWMS
  141.  
  142. ***** To register, please print and fill out the registration form found in the same folder as this document, and send it to:
  143.  
  144. Cinnamon Computer Products
  145. Cinnamon Soft Division
  146. 410 W. Meadow Lane
  147. Marshalltown, IA 50158-5113
  148.  
  149. If sending Cash, be sure to use a security envelope. If you live in Iowa, you must add 5% sales tax ($5.25 is the total). If sending check or money order, please make payable to Cinnamon Computer Products.
  150.  
  151. A replacement copy of the Registration Form, as well as the most recent version of CWMS, can be downloaded from the Cinnamon Soft web site at: http://members.aol.com/dustynk/cinnamonsoft/
  152.  
  153. About Cinnamon Computer Products
  154.  
  155. Cinnamon Computer Products is the trade name of Dusty Kothenbeutel, an interactive game and computer professional, and above all a futurist, living in Marshalltown, IA. Cinnamon Computer Products has two divisions:
  156.  
  157. Cinnamon Soft creates useful software for Mac OS-based computers. Cinnamon WebMaster Suite is the trademark product of Cinnamon Soft, which does not officially produce commercial software at this time. Later on, Cinnamon Soft will become a major software developer for multiple platforms.
  158.  
  159. CinnaByte Internet Services provides high-quality Web Site Design, Web Site Hosting, and Internet- and Mac OS-related Consulation. For more information, send email to dustynk@aol.com, or visit http://members.aol.com/dustynk/cinnabyte/, or write to the address above.
  160.  
  161. Licensing and Distribution Information
  162.  
  163. This version of Cinnamon WebMaster Suite is shareware, and may be freely distributed across the Internet, online services, and BBSs, as long as the entire software package (the Cinnamon WebMaster Suite application and the two accompanying documents "Read Me Please!" and "Registration Form", as well as the folder which contains them) is always included and not modified in any way.
  164.  
  165. You are permitted to use this software on a trial basis for a period of up to 30 days, at which time you must send in the completed registration form and $5.00 registration fee (Iowa residents $5.25 to cover sales tax), or remove the program from your computer. Please send copies of the software package on to everyone you know.
  166.  
  167. The software package may not be included on or in any package or media which is to be sold, or distributed by means other than by modem, without prior written permission (an email response from dustynk@aol.com sufficiently qualifies as written permission) by Cinnamon Soft, with the following exceptions:
  168.  
  169. 1) If you have obtained permission for any previous version of this software package, this permission is hereby extended to this version as well. (I would still like to be notified). However, this rule does not apply if you or the party you represent made payment to Cinnamon Computer Products or Dusty Kothenbeutel in order to secure the prior permission.
  170.  
  171. 2) Permission to include this software package is hereby granted to you ahead of time, without a need to contact Cinnamon Computer Products or Dusty Kothenbeutel prior to the release of your package or product, if a complete copy of the entire package or product is sent to Cinnamon Computer Products at the above address, either free of charge, or with a standard single charge of no more than $5.00 US to cover costs.
  172.  
  173. Contact Cinnamon Soft at the address above for details or to work out an agreement.
  174.  
  175. Future Additions
  176.  
  177. These are just a sampling of features and capabilities which are being planned for addition to future versions of Cinnamon WebMaster Suite:
  178.  
  179. • Totally rewritten in C for speed and capability gains
  180. • Addition of a Preferences file
  181. • Option to deactivate colorization for much faster opening of files
  182.  
  183. • Option to recolorize an already-open document ***** Added in v1.1.2 *****
  184.  
  185. • Option to capitalize all preexisting tags in a document
  186. • Ability to create plain text documents as well as HTML documents
  187. • Find and Replace
  188. • Menu/Command-key shortcuts for commonly used tags
  189. • FKey shortcuts for commonly used tags
  190. • Print routine
  191. • Ability to Undo
  192. • Shortcut for automatically entering end tags (such as </BODY> or </COMMENT>)
  193. • User-definable shortcuts
  194. • and many more!
  195.  
  196. Compatibility
  197.  
  198. Cinnamon WebMaster Suite has been tested and shown to be fully-functional under Mac OS System 7 through 8.1. The program is extremely non-volatile, and thus will likely function without problem on System 6, although it hasn't been tested. No matter what computer model or system version you have, no guarantees are made that this software will function appropriately or at all. You use this software at your own risk. No responsibility or liability on the part of Cinnamon Computer Products shall exist.
  199.  
  200. If you do have any problems of any sort, please report them to me at dustynk@aol.com, or at the address above. I am very grateful for the reporting of any weaknesses or flaws in this software. Please include a detailed summary including a description of what happened, what you were trying to do, your computer model and configuration, any errors or messages you received, what system software you were using, etc. I may be able to suggest an immediate solution, or work one into the next version.
  201.  
  202. Known Problems & Issues
  203.  
  204. ***** A current listing of known bugs & issues will be posted on the Cinnamon *****
  205. ***** Soft website at http://members.aol.com/dustynk/cinnamonsoft/             *****
  206.  
  207. • Choosing Cut, Paste, or Clear from the menu does not register as a change to an unchanged document. FutureBASIC handles the Edit Menu itself and won't allow CWMS to "see" them. (I bet you wouldn't have even noticed this one!) This will be corrected when CWMS is rewritten in C. Workaround 1: Using the command-key shortcuts for Cut or Paste will register as a change. Workaround 2: Make a simple change and undo it.
  208. • Undo is greyed out, because it hasn't been programmed yet
  209. • Preferences is greyed out, because there are no preferences yet
  210. • The Auto-capitalization feature may pose an inconvenience to users of JavaScript. I don't know for sure, but if JavaScript keywords are case-sensitive, they will be incorrectly capitalized when you type the '>'. In a future version this will be remedied, but for now, you can work around this by typing the closing '>' first, then going back and inserting the additional case-sensitive specifiers. Please let me know for sure whether JavaScript keywords are indeed case-sensitive.
  211.  
  212. Version History
  213.  
  214. • 1.0 - January 30, 1998
  215.     * This is the initial release.
  216. • 1.1 - February 8, 1998
  217.     * Added "Insert Color" feature under Edit Menu
  218.     * Added "</!" as a shortcut for "</COMMENT" as an addition to Smart Comments
  219.     * Corrected a problem where "Save" and "Revert" were not activated/deactivated when switching between documents
  220.     * Corrected a minor colorization problem with one variety of Smart Comments
  221. • 1.1.1 - February 16,1998
  222.     * Windows will now behave properly when resized
  223.     * "Insert Color" now registers as a change to the document
  224.     * "Insert Color" is totally revamped to increase functionality and ease of use:
  225.             * The "#" sign only gets inserted if it's not already there
  226.             * Selecting a preexisting hex color code before choosing Insert Color will use the preexisting color as the default in the color picker
  227.             * If no preexisting hex code is selected, the last color to be inserted is the default
  228.     * The information in the "About Cinnamon Computer Products" window was updated to reflect the address of Cinnamon Soft's new website
  229.     * Added new icons. Big thanks to Eric Ward (ericward@xmission.com), they're great! Note: If the icons don't change, you'll need to rebuild your desktop.
  230. • 1.1.2 - February 26, 1998
  231.     * Added "Colorize Tags in Selection" option under Edit menu. Color-codes all the tags & comments in the selected text, just like it says.  8-)   This is done automatically when a document is first opened, but after editing, there can be tags left uncolored.
  232.     * The Colorization process can now be cancelled at any time during the process. The current incarnation of the Colorize routine is very slow on large files--for example, on my computer it takes over 25 minutes to open this Read Me file. In actuality, it takes less than half a second to load the file, and 25 minutes to colorize it, so I added the command-period abort routine to save time and eliminate hassle. You can always use the new Colorize option on selected parts of the file later.
  233.     * You can now make selections using shift-arrow keys. It has some bugs, but it'll do until I can learn how to implement the Macintosh Drag Manager properly.
  234.     * Removed the ellipsis from the "New" option under the File menu. Once I implement some other file types, it will return and be proper. (Thanks to Scott Knick for noticing that one)
  235. • 1.1.3 - March 2, 1998
  236.     * Corrected a bug where a '!' anywhere in a tag would cause it to be comment-colored instead of tag-colored (reported by Scott Knick)
  237.     * Corrected a bug where typing a '!' did not register as a change to the document
  238.     * Includes several new files: An AutoTyper to convert TEXT files to have a CWMS creator type, and a small icon to be included on web pages created with CWMS with a link back to the Cinnamon Soft website.
  239.  
  240. BugZappers Hall of Fame
  241.  
  242. Here's your chance to live forever! Send in a bug report, and get your name in the Hall of Fame! Only new and unknown bugs count. If one of your bugs leads me to another bug, I only count the second one if it was a major one.
  243.  
  244.     1) Scott Knick - 2 bugs
  245.  
  246. Legal Information
  247.  
  248. All products, names, and companies mentioned in this document are the trademarks, registered trademarks, or other property of their respective companies.
  249.  
  250. ©1998 Cinnamon Computer Products. All Rights Reserved.
  251.